/*
 * Copyright 2017 Red Hat, Inc. and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.kie.workbench.common.stunner.core.client.components.views;

import org.kie.workbench.common.stunner.core.client.canvas.Transform;
import org.kie.workbench.common.stunner.core.graph.content.view.Point2D;

/**
 * Shows some content in a tooltip over the Canvas, by the use of
 * some DOM element, which depends on each implementation.
 * @param <T> The content type.
 */
public interface CanvasTooltip<T> {

    /**
     * Sets the absolute location for the Canvas DOM element.
     */
    void setCanvasLocation(Point2D location);

    /**
     * Sets the transform to apply, if any.
     */
    void setTransform(Transform transform);

    /**
     * Shows the content at the specified location.
     */
    void show(T content,
              Point2D location);

    /**
     * Hides the tooltip.
     */
    void hide();

    /**
     * Destroys the tooltip.
     */
    void destroy();
}
